/*! ******************************************************************************
 *
 * Pentaho Data Integration
 *
 * Copyright (C) 2002-2017 by Hitachi Vantara : http://www.pentaho.com
 *
 *******************************************************************************
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 ******************************************************************************/

package org.pentaho.metaverse.api;

/**
 * The IAnalyzer interface provides methods for analyzing types of content (with a goal of integrating with the
 * metaverse)
 * 
 */
public interface IAnalyzer<S, T> extends IRequiresMetaverseBuilder {

  /**
   * Analyze the given object.
   * 
   * @param object
   *          the object
   * @return the root node resulting from the analysis of the specified object
   * @throws MetaverseAnalyzerException
   *           the metaverse analyzer exception
   */
  S analyze( IComponentDescriptor descriptor, T object ) throws MetaverseAnalyzerException;

}
